home *** CD-ROM | disk | FTP | other *** search
/ HyperLib 1997 Winter - Disc 1 / HYPERLIB-1997-Winter-CD1.ISO.7z / HYPERLIB-1997-Winter-CD1.ISO / オンラインウェア / UTIL / Alpha 6.5.sit / Help / Alpha Commands < prev    next >
Text File  |  1996-07-16  |  37KB  |  702 lines

  1. ==============================================================================
  2. = Alpha Commands
  3. ==============================================================================
  4.  
  5. In this list of routines, text between '<' and '>' is a placeholder for a 
  6. required parameter, text between '[' and ']' is a placeholder for an 
  7. optional parameter, and the '|' signifies a choice of two or more 
  8. alternatives.  A '+' signifies that the previous symbol can be present one 
  9. or more times, while a '*" means zero or more times.  Some commands have no 
  10. parameters, and are only expected to be called interactively.
  11.  
  12.  
  13.  
  14. The following are Alpha-specific tcl routines:
  15.  
  16. ・ abortEm - aborts whatever is currently happening
  17. ・ abbrev <label> <string> [<mode>] - register a label for <string>. See 
  18. 'execAbbrev'.
  19. ・ addAlphaChars <chars> - Add <chars> to the list of characters that internally 
  20.   are caught by the 'isalnum' and 'isalpha' calls. Can be used to augment 
  21.   the list of characters that the ¥w pattern in a regular expression 
  22.   responds to. Use w/ care.
  23. ・ addMenuItem [-m] [-l <meta-characters>] <menu name> <item name> - Convert
  24.   item to menu form and add to specified menu. If '-m' specified, menu 
  25.   form conversion not done. The '-l' option allows you to use menu meta 
  26.   characters as text of menu items. If the '-l' option is used, the 
  27.   <meta-characters> string is interpreted for menu item attributes, and 
  28.   meta-characters in <item name> are included in the menu item text 
  29.   literally. For example: 
  30.       addMenuItem -m -l "/B" "Hello/C" 
  31.   would appear as the text "Hello/C" in the menu, and have "B" as its 
  32.   command equivalent.
  33. ・ addDef <var> <val> - Permanently save an association between the var 
  34.   'var' and 'val'. 'addDef' and 'addArrDef' are now the sanctioned way to 
  35.   save values between sessions. Also see 'removeDef' and 'removeArrDef'.
  36. ・ addArrDef <var> <field> <val> - Permanently save an association between 
  37.   the var var(field) and 'val'.
  38. ・ AEBuild [<flags>] <app (name|creator)> <aesuite> <aeevent> [<event parameters>]*  -
  39.   Build and send an apple-event. 'AEBuild' is apple's code of the same 
  40.   name. Each "event parameter" is two parameters, a parameter type and 
  41.   the data for the parameter. See the AEBuild doc for more details, 
  42.   :Tcl:SystemCode:think.tcl for examples. The flags are '-r' (wait for reply), 
  43.   '-q' (queue reply, in which case 'handleReply' (in appleEvents.tcl) is 
  44.   called with the reply as a parameter, and '-t <timeout>' specifies the 
  45.   timeout in ticks.
  46. ・ alertnote message_string
  47.   This command will display message_string in a standard Macintosh alert box.
  48. ・ alphaHelp - display Alpha help.
  49. ・ ascii (see bindings).
  50. ・ askyesno [-c] prompt
  51.   This command will display a Macintosh alert box with 'prompt' displayed
  52.   with the push buttons Yes and No. The command will return the 
  53.   string "yes" or "no". The '-c' flag specifies that a cancel button be 
  54.   used as well.
  55. ・ backColor - set background color
  56. ・ backSpace - delete selection, or a single char if no selection.
  57. ・ backwardChar - moves insertion one char back
  58. ・ backwardCharSelect - extends selection one char back
  59. ・ backwardDeleteWord - deletes previous word
  60. ・ backwardWord - moves insertion one word back
  61. ・ balance - selects smallest set of parens, braces, or 
  62.   brackets that encloses the current selection
  63. ・ beep
  64. ・ beginningBufferSelect - extend selection to the 
  65.   beginning of the buffer
  66. ・ beginningLineSelect - extend selection to the 
  67.   beginning of the line
  68. ・ beginningOfBuffer - move insertion to the beginning 
  69.   of the buffer
  70. ・ beginningOfLine - move insertion to the beginning of 
  71.   the line
  72. ・ bind  (see bindings)
  73. ・ blink <pos> - blink cursor at 'pos'
  74. ・ breakIntoLines <string> - return 'string' with 
  75.   carriage returns and spaces inserted to satisfy 
  76.   'leftFillColumn' and 'fillColumn' variables.
  77. ・ bringToFront <winName> - Bring named window to front.
  78. ・ buttonAlert <prompt> [<button>ノ] - Create a dialog w/ the specified 
  79.   buttons, returning the one selected.
  80. ・ capitalizeRegion - capitalize all words in selected 
  81.   region 
  82. ・ capitalizeWord - capitalize word
  83. ・ centerRedraw - redraw window with current line in 
  84.   the middle.
  85. ・ clear - clear selected text
  86. ・ closeAll - close all windows
  87. ・ colors <fore red> <fore green> <fore blue> <back red> <back green> <back blue>
  88. ・ colorTriple [<prompt>] [<red> <green> <blue>] - Prompts user to choose 
  89.   color. If specified, the input RGB value is used as the initial color on 
  90.   the colorpicker.
  91. ・ copy - copy region
  92. ・ cp <fromName>+ <toName>
  93.   This command will copy the file fromName and name the new file toName, 
  94.   overwriting any existing file. This command copies both data forks, and 
  95.   the Finder information. 
  96. ・ createTagFile - searches all files in current file set 
  97.   and saves the locations of any function declarations
  98.   in a file called 'cTAGS'.
  99. ・ createTMark <name> <pos> - create a temporary 'mark' 
  100.   at location 'pos'. 
  101. ・ currentPosition - displays current and total bytes.
  102. ・ cut - deletes and saves region
  103. ・ decToHex - convert decimal number to hex.
  104. ・ deleteChar - delete char AFTER cursor
  105. ・ deleteMenuItem [-m] <menu name> <item name> - Convert item to menu form 
  106.   and delete from specified menu. If '-m' specified, menu form conversion 
  107.   not done. 
  108. ・ deleteModeBindings <mode> - Delete all bindings for specified mode.
  109. ・ deleteSelection - delete current position, don't save
  110. ・ deleteWord - delete word after cursor
  111. ・ describeBinding - display the binding of the next typed key sequence. 
  112. ・ deleteText <pos1> <pos2> - remove text between 'pos1' 
  113.   and 'pos2'
  114. ・ dialog [<-w width>|<-h height>|<-b title l t r b>|<-c title val l t r b>|
  115.             <-t text l t r b>|<-e text l t r b>|<-r text val l t r b>|
  116.             <-p l t r b>]+ 
  117.   Create and display a dialog.  '-w' and '-h' allow width and height of 
  118.   dialog window to be set.  '-b', '-c', '-r', '-t', '-e' and '-p' allow 
  119.   buttons, checkboxes, radio buttons, static text, editable text and gray 
  120.   outlines to be created, respectively.  All control types (except gray 
  121.   outlines) require specification of a title or text, together with left, 
  122.   top, right, and bottom coordinates.  Checkboxes and radioboxes have an 
  123.   additional parameter, the default value.  At least one button must be 
  124.   specified.  The return value is a list containing resulting values for 
  125.   all buttons, radioboxes, checkboxes, and editable textboxes (static text 
  126.   is ignored).  Buttons have value '1' if chosen, '0' otherwise.  The 
  127.   dialog box exits at the first button press.
  128.  
  129. ・ dirs - show current directory stack. See 'pushd' and 'popd'.
  130. ・ display [-w <win>] <pos> - move pos's line to top of screen.
  131. ・ displayMode <mode> - Up to four characters of the 'mode' string are 
  132.   displayed in the status line at the bottom of a window.
  133. ・ dosc [<-c 'sign' | -n appName>] [-k 'clas'] [-e 'evnt'] <-s string | -f fileName> [<-t timeout|-r>]
  134.   Send an AppleEvent, by default class 'misc', event 'dosc'.
  135.    -c 'sign' 
  136.            "sign" is a four-letter creator signature of a running application.
  137.    -n appName
  138.            "appName" is the name of a running application.
  139.    -k 'clas'
  140.            "clas" is a four-letter event class.
  141.    -e 'evnt'
  142.            "evnt" is a four-letter event class.
  143.    -s string
  144.            "string" is the text of a script to send to the other app.
  145.    -f fileName
  146.            "fileName" is the complete or relative pathname of a file the other 
  147.            application should execute.
  148.    -t timeout
  149.            "timeout" is the number of ticks Alpha should wait for a response. A 
  150.            timeout of "0" means wait forever.
  151.    -r
  152.            Do not wait for reply.
  153.    -q
  154.            Queue reply.
  155.            
  156.    If neither of the '-c' and '-n' options is chosen, the PPC Browser is 
  157.    used. Either '-s' or '-f' must be chosen. Thus, you can have "Alpha 
  158.    5.02" and "Alpha 5.02 Copy" sending Apple events to each other, or they 
  159.    can send events to a remote server such as Apple's ToolServer. 
  160.    "$HOME:Tcl:UserCode:createStuffitArchive.tcl" contains examples of 
  161.    controlling Stuffit Deluxe via this command.
  162. ・ downcaseRegion - changes all uppercase letters to 
  163.   lowercase in current region
  164. ・ downcaseWord - changes all uppercase letters to 
  165.   lowercase in current word
  166. ・ dumpColors - dump current foreground and background
  167.   colors into the current buffer in Alpha-readable
  168.   format.
  169. ・ dumpMacro - prompts for a name and then dumps a tcl proc representation 
  170.   of the current keyboard macro into the current window.
  171. ・ echo <string>* - echo the strings (used 
  172.   in shells).
  173. ・ edit [-r] [-m] [-c] [-w] [-g <l> <t> <w> <h>] <name> - Open a file in new 
  174.   window. '-c' means don't prompt for duplicate win if file already open.
  175.   '-r' means open the file read-only. '-m' means omit the function titlebar 
  176.   menu and present only the marks titlebar menu, which is labeled with the 
  177.   contents of 'markLabel'. The '-g' option allows left and top coords to 
  178.   be specified, plus width, and height. All or none. '-w' allows you to
  179.   bypass the "Wrap" dialog for files with long rows.
  180. ・ enableMenuItem <menuName> <item text> <on|off> - Either enable or 
  181.   disable the menu item of user menu 'menuName' that has text '<item 
  182.   text>'. Note that unless the menu is not only created, but also already
  183.   inserted, this command has no effect. 
  184. ・ endBufferSelect - extend selection to the end of the 
  185.   buffer
  186. ・ endKeyboardMacro - stop recording keyboard macro
  187. ・ endLineSelect - extend selection to the end of line
  188. ・ endOfBuffer - move insertion to the end of the buffer
  189. ・ endOfLine - move insertion to the end of the line
  190. ・ enterSelection - use current selection for future searches.
  191. ・ eventHandler [class] [event] [proc] - Register 'proc' to handle the class 
  192.   and event specified. Class and event are each 4 char args. 'proc' takes 
  193.   a single argument that specifies the incoming event according to the 
  194.   syntax here. There is currently no provision for a reply.
  195. ・ exchangePointAndMark - exchange the current 'mark' 
  196.   w/ the current insertion point
  197. ・ execAbbrev - looks at current word and tries to expand it. Labels are 
  198.   specified using 'abbrev'.
  199. ・ execute - prompt user for a function or macro. The 
  200.   tab key acts as a "completion" command.
  201. ・ executeKeyboardMacro - execute the current keyboard 
  202.   macro
  203. ・ fileInfo - prompts for a file, and displays type, 
  204.   creator, sizes of both data and resource forks, last
  205.   modification time, and creation time
  206. ・ fileRemove - prompts for a file, and removes it
  207. ・ find - bring up the find dialog
  208. ・ findAgain - repeat search forward
  209. ・ findAgainBackward - repeat search backward
  210. ・ findFile - open a file in a new window
  211. ・ findInNextFile - search next file.
  212. ・ findTag - prompt user for a function name and attempt 
  213.   to use the file 'cTAGS' to locate the function's 
  214.   definition
  215. ・ float -m <menu> [<-h|-w|-l|-t|-M> <val>] [-n winname] [-z tag] -
  216.   Takes a created menu (not necessarily in the menubar), and makes a 
  217.   floating window out of it. Returns integer tag that is used to remove 
  218.   the window. NOT DYNAMIC!  W/ no options returns all currently defined menus.
  219.   Displayed w/ system floating window WDEF if system 7.5, plainDBox 
  220.   otherwise. -h through -M change width, height, left margin, top margin, and
  221.   margin between buttons. -z allows a ten-char tag to be specified for 
  222.   'floatShowHide'.
  223. ・ floatShowHide <on|off> <tag> - Shows or hides all floats w/ specified 
  224.   tag. Tags of current modes are automatically shown/hidden.
  225. ・ forwardChar - move insertion one character forward
  226. ・ forwardCharSelect - extend selection one character 
  227.   forward
  228. ・ forwardWord - move insertion one word forward
  229. ・ freeMem - give a rough approximation of the current 
  230.   memory reserves of ALPHA
  231. ・ get_directory [-p <prompt>]
  232.   This command will display a standard Macintosh file dialog and request the user 
  233.   select a folder. The command will return the selected folder's full path name, or an 
  234.   empty string if the Cancel button was selected.
  235. ・ getAscii - displays the ASCII code for character at 
  236.   current insertion point
  237. ・ getChar - waits for a keystroke, returns ascii.
  238. ・ getColors - returns list of colors/hypertext for current document. 
  239.   Format is list of lists, each sublist consisting of file offset, color 
  240.   index, and possibly a hypertext command.
  241. ・ getfile <prompt>
  242.   This command will display an SFGetFile() and return the full path name of the 
  243.   selected file, or an error if CANCEL button was selected.
  244. ・ getFileInfo <file> <arr> - Given a file name, creates an array called 
  245.   'arr' in the current context, containing fields 'created', 'creator', 
  246.   'modified', 'type', 'datalen', and 'resourcelen'. 'created' and 
  247.   'modified' are in a form suitable for the command 'mtime'.
  248. ・ getGeometry [win] - return a TCL list containing the left 
  249.   edge of the current window, the top, the width, and height.
  250. ・ getline <prompt> <default>
  251.   This command will display a Macintosh alert box with prompt displayed, a 
  252.   text edit field with default initially in the field, and with the push 
  253.   buttons OK, Cancel.. The command will return the text entered into the 
  254.   text edit field by the user, or an empty string if the user selected the 
  255.   Cancel button. 
  256. ・ getMainDevice - return a list containing the left, top, right, and 
  257.   bottom of the rectangle defining the main device.
  258. ・ getMark - return the current mark.
  259. ・ getNamedMarks [-w <win>] [-n] - 
  260.   return list of all permanent marks in open files. Each
  261.   element of a list describes one mark as a sublist of the mark's name, 
  262.   the complete pathname of the mark's file, the position of the first 
  263.   character in the first line displayed, the current position, and the 
  264.   end of the selection if text is hilited, or the current position again 
  265.   if there is no hilited section. '-w' allows window name to be applied 
  266.   as filter, '-n' means only names will be returned.
  267. ・ getPathName - prompt the user with an SFGetFile dialog and return 
  268.   complete pathname.
  269. ・ getPos [-w <win>] - return the current insertion point
  270. ・ getScrap - returns system TEXT scrap.
  271. ・ getSelect - return the currently selected text, if 
  272.   any.
  273. ・ getText [-w <win>] <pos1> <pos2> - return the text between 'pos1' 
  274.   and 'pos2'. '-w' can be used to specify a window.
  275. ・ getTMarks - Return a list of temporary marks. Each item of the returned 
  276.   list is a sublist containing the mark name, the complete pathname of the 
  277.   mark, and the start and finish of the selection named by the mark. The 
  278.   following is an example of the result: 
  279.  
  280.     {{temp1 External:file.c 1312 1315} {temp2 Internal:it.h 111 111}} 
  281.  
  282. ・ getWinInfo [-w <win>] <arr> - Creates an array in current context 
  283.   containing info about either the current or a specified window. Array 
  284.   has fields 'state', 'platform', 'read-only', 'tabsize', 'split', 
  285.   'linesdisp' (num lines that can be seen in the window), 'currline' 
  286.   (first line displayed), and 'dirty'.
  287. ・ glob [-i] [-t <TYPE>] [-c <CRTR>]
  288.   The original glob provided by the UNIX version of tcl was not quite 
  289.   adequate for the more complex Macintosh file system. Issues such as 
  290.   invisible file handling, Finder type and creator filtering, and space 
  291.   handling in file names. Release 6 of tcl has dealt with the original 
  292.   problem with spaces in filenames, but the following options are provided 
  293.   to deal with additional Macintosh issues. 
  294.  
  295. Anyway, the new glob now takes several options. They are:
  296.     -i    This option causes glob to list invisible files also.
  297.     -t TYPE    This option causes glob to only list file with the 
  298.         indicated Finder file typeTYPE. This option may be 
  299.         used with the -c option.
  300.     -c CRTR    This option causes glob to only list file with the 
  301.         indicated Finder file creatorCRTR. This option may 
  302.         be used with the -t option.
  303.         Also note that the original glob would skip dot files
  304.         (i.e., file names the begin with a period) 
  305.         in the listing, unless the pattern began with a period.
  306.         Tickle extends this concept one step further on the
  307.         Macintosh, and skips spot files (i.e., file names that 
  308.         begin with '・'), unless the pattern starts with a spot.
  309. ・ goto <pos> - goto the position 'pos'.
  310. ・ gotoMark - goto named mark, use 'mark' in macros.
  311. ・ gotoTMark <name> - goto the temporary mark 'name'.
  312. ・ hexToDec <num> - hex to decimal conversion.
  313. ・ icon [-f <winName>] [-c|-o|-t|-q] [-g <h> <v>] - Having to do w/ 
  314.   iconifying windows. '-c' means close (iconify) window, '-o' open, '-t' 
  315.   toggle open/close, '-q' returns either a '1' for an iconified window or a 
  316.   '0' for an uniconified window, and '-g' moves the icon to horizontal 
  317.   position <h> and vertical position 'v'. Options are executed as they 
  318.   are parsed, so the '-f' option, if present, should always be first. 
  319. ・ icURL <URL> - passes arg to Internet Config, if present. Error if not 
  320.   present. 
  321. ・ icGetPref [<-t <type>] <pref name> - Gets preference from 
  322.   Internet Config. '-t' allows type to be set, '0' returns a string 
  323.   (default), '1' returns a path name, commonly used for helper apps. A 
  324.   <pref name> of 'all' returns all valid preferences.
  325. ・ icOpen - Opens Internet Config
  326. ・ insertAscii - prompts for an ASCII code and inserts
  327.   into text.
  328. ・ insertColorEscape <pos> <color ind> [hypertext func] - Create a color 
  329.   or style "point" for documentation purposes. Look at the file 
  330.   "docColors.tcl" for examples. The hypertext func is only used when the 
  331.   "point" is underline. See 'getColors' for info about the current file.
  332. ・ insertFile - prompts for a file name and inserts the
  333.   corresponding file into the current window. Not
  334.   undoable.
  335. ・ insertMenu <name> - insert the previously created user menu 'name' into 
  336.   the menuBar. 
  337. ・ insertPathName - present the user w/ a SFGetFIle dialog 
  338.   and paste the complete path-name of the chosen file
  339.   into the current window
  340. ・ insertText [-w <win name>] <text>* - Insert 'text' at the current 
  341.   insertion point.
  342. ・ insertToTop - make the line that the insertion point 
  343.   is on the first line shown, and display the current 
  344.   line number along w/ the total number of lines in file
  345. ・ isearch - incremental search: searches w/o a dialog,
  346.   searches as you type the search pattern. Does not do
  347.   regular expression searches. 'matchWords' 
  348.   automatically set to false.
  349. ・ iterationCount - allows actions to be repeated many times. "control-u 44 
  350.   =" inserts 44 '='s into current window.  Also can be used to execute any 
  351.   function or macro (including the keyboard macro) many times.  Defaults to 
  352.   4.
  353. ・ jumpToRegister - prompts for a single char, and then jumpts to 
  354.   temporary mark of that name created by 'pointToRegister'.
  355. ・ keyAscii - insert ascii representation (in decimal)
  356.   of the keydown event, plus a modifier string, if 
  357.   necessary.
  358. ・ keyCode - insert the key code along w/ a string 
  359.   representing and modifiers into the current window.
  360.   Can be used to create bindings in 'Alphabits'.
  361. ・ killLine - kill text from insertion point to the end 
  362.   of the line. If the line has no text, delete the line 
  363.   and move succeeding lines up one.
  364. ・ killWindow - kill current window
  365. ・ largestPrefix <list> - Returns the longest prefix contained in all 
  366.   strings of 'list'.
  367. ・ launch -f <name> - launch the named app into the background. Note that 
  368.   for some yet unexplained reason, some applications (MicroSoft Word) 
  369.   won't launch completely in the background. 'launch'ing such 
  370.   applications won't insert the application into any system menu that 
  371.   specifies running applications (although "About the Finder..." will 
  372.   list it. The only way to get to such an app is through Alpha's 
  373.   'switchTo', after which the application will finish launching. The '-f' 
  374.   option gets around this by launching the application in the foreground 
  375.   instead.
  376. ・ lineStart <pos> - return the position of the start of
  377.   the line 'pos' is on.
  378. ・ listBindings - list all current bindings.
  379. ・ listpick [-p <prompt>] [-l] [-L <def list>] <list>
  380.   This command will display a dialog with the list displayed in a List Manager 
  381.   list. If the user presses the Cancel button, an empty string is returned. If 
  382.   the user selects the Open button, or double clicks an item in the list, that 
  383.   item will be returned. If '-l' is specified, than the return is a list of 
  384.   items.
  385. ・ load - loads hilited text, or entire window if 
  386.   nothing is hilited. 'load'ing means that whatever 
  387.   bindings or macro definitions are present in the 
  388.   loaded text take effect
  389. ・ lookAt [-w <name>] <pos> - return the 'pos'th character of the 
  390.   current file, or the file named by <name> if the '-w' option is specified.
  391. ・ markHilite - This is the 'Hilite' from the 'Edit'
  392.   menu. If there is a currently hilited selection, the 
  393.   selection is unhilited, leaving the mark and the 
  394.   insertion point around the old selection. If there 
  395.   is not a selection, the region between the insertion 
  396.   point and the mark is selected.
  397. ・ markMenuItem [-m] <menuName> <item text> <on|off> [<mark char>] - Either mark or unmark
  398.   the menu item of user menu 'menuName' that has text '<item text>'. 
  399.   Note that unless the menu is not only created, but also already
  400.   inserted, this command has no effect. 
  401. ・ matchBrace - moves the insertion point to the 
  402.   character that matches the character after the current 
  403.   insertion point
  404. ・ matchIt <brace char> <pos> - Return pos of matching brace. Recognizes 
  405.   parenthesis, square brackets, and curly braces.
  406. ・ maxPos [-w <win>] - returns the number of characters in the front
  407.   window.
  408. ・ menu [-s] [-n <name>] [-i <num] [-m] [-M <mode>] [-p <procname>] <list of menu items> - 
  409.   Defines a new menu named 'name' (if provided w/ '-n' option). The menu is not 
  410.   yet inserted into the menubar. The menu commands may be nested for 
  411.   heirarchical menus, see 'AlphaBits.tcl' for examples. Alpha massages the 
  412.   function names to make them look better in the menus. 
  413.   '-c'            Ignore any menu meta-chars. Can also be done on a per-item basis 
  414.                   by appending an ampersand ('&') to the end of an item.
  415.   '-s'            Use system menu definition proc (faster).
  416.   '-n <num>'    Resource id of icon suite to use for menu title. 'ics#' 
  417.                 is the only resource that is really necessary.
  418.   '-n <name>'    Name the menu. Not necessary for submenus.
  419.   '-m'            No menu form. If not supplied, each menu item is split into 
  420.                   words at each capitalized letter.
  421.   '-p <name>'     The tcl proc named by 'name' is called w/ the menu's name
  422.                   and the item's contents when the item is chosen.
  423.   '-M <mode>'    Specifies that any bindings created by the menu are 
  424.                   specific to a given mode. This is important because mode-specific
  425.                   bindings over-ride global bindings.
  426. ・ message <string> - prints 'string' on the status line.
  427. ・ mkdir <name> - creates a directory (folder) named 
  428.   'name' in the current directory.
  429. ・ mousePos - Returns list <row,col> of mouse position, if the mouse is 
  430.   currently over the active window. Otherwise, return error (catch w/ 
  431.   'catch').
  432. ・ moveInsertionHere [-last] - move the insertion point to the 
  433.   first (or last) line displayed
  434. ・ moveFile <fromName> <toName>
  435.   This command will move the file fromName to toName, overwriting any 
  436.   existing file. The move can not be made across volume (disk drives) 
  437.   boundaries. 
  438. ・ moveWin [win name] <left> <top> - moves current or specified window. 
  439.   The window name can be "StatusWin".
  440. ・ mtime <time> [long|short|abbrev]
  441.   Returns a date and time string using the Macintosh International Utilities. The 
  442.   long/short/abbrev specification corresponds to the date. These are the following 
  443.   formats:
  444.     short        3/16/92 9:20:46 PM
  445.     abbrev    Mon, Mar 16, 1992 9:20:49 PM
  446.     long        Monday, March 16, 1992 9:20:43 PM
  447.   The returned value actually is in the form of a list. To get text as 
  448.   above, run the result through 'join', as in "join [mtime [now] short]".
  449. ・ nameFromAppl '<app sig>' - Interrogates the desktop database for the first 
  450.   existing app that has the desired signature. <app sig> is four chars 
  451.   inside single quotes.
  452. ・ new [-g <l> <t> <w> <h>] [-n <name>] - opens an untitled window. Can optionally 
  453.   provide left and top coordinates, plus width and height. All or none.
  454. ・ nextLine - move insertion point to next line
  455. ・ nextLineSelect - extend selection to the next line
  456. ・ nextLineStart <pos> - return the position of the start 
  457.   of the next line after position 'pos'.
  458. ・ nextSentence - go to next sentence ("fill.tcl").
  459. ・ nextWindow - select next window
  460. ・ now
  461.   Returns the current time as Macintosh seconds. This is the number of seconds that 
  462.   have elapsed since Midnight Jan 1, 1904.
  463. ・ oneSpace - converts whitespace surrounding insertion
  464.   into a single space.
  465. ・ openLine - insert a new line following the current 
  466.   one and move the insertion point to it
  467. ・ otherPane - If window is split, select the other pane.
  468. ・ pageBack - display prev screenful, move the
  469.   insertion point if 'moveInsertion' enabled
  470. ・ pageForward - display next screenful, move the
  471.   insertion point if 'moveInsertion' enabled
  472. ・ pageSetup - display the printing PageSetup dialog.
  473. ・ paste - insert the last chunk of text created by 'cut' 
  474.   or 'copy'
  475. ・ pointToRegister - prompts for a single character, and then assigns a 
  476.   temporary mark of that name to the current insertion point. Point can 
  477.   be jumped to via 'jumpToRegister'.
  478. ・ popd - Pop top dir off dir stack and 'cd' to it.
  479. ・ posToRowCol <pos> - converts from absolute position to row, col.
  480. ・ prefixChar - used to further modify the next keystroke 
  481.   combination, in the same manner as using the shift key 
  482.   in the next keystroke
  483. ・ previousLine - move insertion point to the previous 
  484.   line
  485. ・ prevLineSelect - extend selection to the previous line
  486. ・ prevSentence - go to previous sentence ("fill.tcl").
  487. ・ prevWindow - select previous window
  488. ・ print - print front window
  489. ・ processes - returns info of active processes. A list of lists, each 
  490.   sublist contain a file-name, an application signature, the application 
  491.   memory size, and the number of ticks the application has been active.
  492. ・ prompt <prompt> <default> [<name> <menu item>*] - prompt dialog to 
  493.   the user with a prompt string and a default value. The prompt dialog can 
  494.   optionally include a popup menu specified by 'name' and the succeeding 
  495.   strings. Selection of the popup menu items inserts the item text into the 
  496.   editable dialog item. 'Prompt' returns the value of the editable item. 
  497.   If the 'Cancel' button is selected, the tcl returns an error and your 
  498.   script will be stopped unless you execute the command from 'catch'.
  499. ・ pushd [<dir>] - If 'dir' specified, push current folder into directory 
  500.     stack and 'cd' to dir. Otherwise, swap current dir w/ top of dir stack.
  501. ・ putfile <prompt> <original>
  502.   This command will display an SFPutFile() and return the full path name of the 
  503.   selected file, or an empty string if CANCEL button was selected. Original is the 
  504.   default name displayed for the user.
  505. ・ putScrap [<string>]+ - Concatenate strings together into the system 
  506.   scrap. The scrap can be appended to through calls of the form 'putScrap 
  507.   [getScrap] " another word"'.
  508. ・ pwd
  509.   This command will return the current working directory, ending in a colon.
  510. ・ quit - quits ALPHA
  511. ・ rectMarkHilite - creates a rectangular selection 
  512.   between the mark and the insertion point.
  513. ・ redo - redo the next action that has been undone but 
  514.   not redone
  515. ・ regModeKeywords [options] <mode> <keyword list> - Set keywords and comments that 
  516.   Alpha can recognize to color them. Specifically, in mode <mode>, every 
  517.   keyword specified in the list is colored non-black (blue, by default). 
  518.   Comments, if specified by '-e' or '-b' below, are colored red by defualt.
  519.     -a                                Keywords will be *added* to existing mode
  520.                                     keywords. The new keywords can be a different
  521.                                     color than older keywords. This flag can also be
  522.                                     used to modify other attributes, but it cannot be
  523.                                     used to modify colors of existing keywords.
  524.     -m <c>                            Specify a magic character. Every word beginning with the 
  525.                                     magic character is a keyword.
  526.     -e <commentstr>                    Specify a string that begins comments that last to 
  527.                                     the end of the line. 
  528.     -b <comment beg> <comment end>    Specify a pair of strings that bracket a 
  529.                                     comment.
  530.     -c <color>                        Comment color.
  531.     -k <color>                        Keyword color.
  532.     -s <color>                        String color. Alpha can color single-line
  533.                                     strings only, using the simple heuristic
  534.                                     of assuming the first two double quotes
  535.                                     constitute a string. 
  536.     -i <char>                        Specify a character to display differently.
  537.                                     Commonly used for curly braces, etc.
  538.     -I <color>                        Color of above characters.
  539.     Keywords must be less than 20 characters long.
  540. ・ removeArrDef <var> <field> - Remove the pernament definition of 
  541.  'var(field)'. See 'addDef' and 'addArrDef'.
  542. ・ removeDef <var> - Remove the permanent definition of 'var'.
  543. ・ removeFile <fileName>
  544.   This command will delete the file or folder 'fileName'.
  545. ・ removeMark [-all]|[[-n <mark name] [-w <specname>]]- allows marks to be 
  546.   removed. If no options are specified, it's interactive.
  547. ・ removeMenu <name> - remove menu 'name' from menubar, except those 
  548.   specified by previous 'makeMenuPermanent' calls.
  549. ・ removeTMark <name> - remove temporary mark.
  550. ・ replace - replace the current selection
  551. ・ replaceAll - replace all further occurrences in the current file.
  552. ・ replace&FindAgain - replace the current selection and find next 
  553.   occurrence.
  554. ・ replaceString [<str>] - specifies replacement string. Returns current 
  555.   replacement string if no arg.
  556. ・ replaceText <pos1> <pos2> [text]+ - replaces the text
  557.   between 'pos1' and 'pos2' with 'text', where 'text' can be any number 
  558.   of arguments. Leaves insertion at end, mark at beginning of inserted 
  559.   text. 
  560. ・ restoreVars - restore variables to saved state, 
  561.   see 'saveVars'
  562. ・ revert - revert the file to its last saved version
  563. ・ rmdir <dirname> - remove a directory (folder)
  564. ・ rowColToPos [-w <win>] <row> <col> - converts to abosolute position.
  565.   Accepts optional -w parameter that allows window to be specified.
  566. ・ rsearch - reverse incremental search, see 'isearch'.
  567. ・ save - save current window
  568. ・ saveAs [def name] - save current window with new name. Optionally takes 
  569.   a default filename. Returns complete path of saved file, if ok hit, 
  570.   otherwise TCL_ERROR returned.
  571. ・ saveVars - save variable state, see 'restoreVars'
  572. ・ scrollDownLine - same action as that which occurs when 
  573.   the down arrow in the vertical scrollbar is selected
  574. ・ scrollLeftCol - same action as that which occurs when
  575.   the left arrow in the horizontal scrollbar is selected
  576. ・ scrollRightCol - same action as that which occurs when
  577.   the right arrow in the horizontal scrollbar is 
  578.   selected
  579. ・ scrollUpLine - same action as that which occurs when 
  580.   the up arrow in the vertical scrollbar is selected
  581. ・ search  [optionsノ] <pattern> <pos> - 
  582.   -f <num>        - go forward?
  583.   -r <num>        - regular expression?
  584.   -s            - save previous search string and search flags.
  585.   -i <num>        - ignore case?
  586.   -m <num>        - match words?
  587.   -n            - failed search still returns TCL_OK, but null string.
  588.   -l <limit>    - limit on how search goes.
  589.   --             - next arg is the pattern.
  590.  
  591.   Searches for 'pattern' from position 'pos'.  If the search succeeds, a 
  592.   list of two positions will be returned.  The first is the starting position 
  593.   of the match, the second is one past the last character. If no '-n', 
  594.   TCL_ERROR returned.
  595. ・ searchString [<str>] - allows search string to be specified. Returns 
  596.   current searchstring if no arg.
  597. ・ select <pos1> <pos2> - selects the text between 'pos1' 
  598.   and 'pos2'.
  599. ・ selEnd [-w <win] - returns the end of the hilited selection, or 
  600.   the current insertion point if no text is selected.
  601. ・ sendOpenEvent [filler] <app name> <file name> - Send an open doc event to 
  602.   another currently running application. If 'filler' is noReply, then a 
  603.   reply is not requested. Otherwise, we wait for a reply and 'filler' is 
  604.   ignored. 
  605. ・ sendToBack <winName> - Sent named window to back.
  606. ・ setFileInfo <file> <field> [arg] - Allows some information to be set 
  607.   for files. Settable fields are 'modified', 'created', 'creator', and 
  608.   'type' all take an argument. 'resourcelen' can be set, but doesn't take 
  609.   an argument and just removes the resource fork.
  610. ・ setFontsTabs - bring up font and tab dialog
  611. ・ setMark - set the current mark to the insertion point
  612. ・ setNamedMark [name disp pos end] - set named mark. If optional arguments are 
  613.   present, the mark is created without prompting user. 'disp' is the 
  614.   character position of the start of the first line to be displayed, 
  615.   while 'pos' and 'end' bracket the text to be selected.
  616. ・ setWinInfo [-w <win>] <field> <arg> - Sets a piece of data about either 
  617.   the current or a specified window. Settable fields 'platform', 'state', 
  618.   'read-only', 'tabsize', 'dirty', and 'shell'. 'shell' means that dirty 
  619.   flag ignored and undo off.
  620. ・ shell - open the Tcl shell.
  621. ・ shiftLeftRegion - shifts the current region left a tab
  622. ・ shiftRightRegion - shift the current region right a 
  623.   tab
  624. ・ sizeWin [win name] <width> <height> - sets size of current or specified window.
  625.   The window name can be "StatusWin", although only the width can be 
  626.   changed.
  627. ・ sortMarks - sorts all marks of open windows, w/o 
  628.   setting the dirty flag. If the files are saved, the 
  629.   marks will be saved in alphabetical order.
  630. ・ spacesToTabs - convert spaces in selection to tabs
  631. ・ specToPathName [hex data] - given an FSSpec in hex form (as that 
  632.   returned by aebuild, for instance, see the definition of thinkFileName 
  633.   in :Tcl:SystemCode:think.tcl), return a complete pathname.
  634. ・ splitWindow [percent] - toggle having window split into two panes. 
  635.   Optional arg specifies percent of window to allocate to the first pane. 
  636. ・ startEscape - used to further modify the next 
  637.   keystroke combination, in the same manner as using the 
  638.   shift key in the next keystroke
  639. ・ startKeyboardMacro - start recording keyboard macro
  640. ・ statusPrompt <prompt> [<func>] - Prompt in the status window. If 'func' 
  641.   is present, call this routine at each key-press with the current 
  642.   contents of the status line and the key, insert into statusline 
  643.   whatever is returned by the func. Command-v pastes the current (<80 
  644.   char) clipboard contents on the status line.
  645. ・ substituteVars <string> - Takes a single string and
  646.   substitutes for all variables inside it, regardless of
  647.   depth. Unfortunately, you currently need to make 'global var' 
  648.   declarations in the proc you call this for each 'var' that might need 
  649.   to be substituted in the string (see proc.tcl for examples).
  650. ・ switchTo <appName> - Switches to application 'appName'.
  651. ・ tab - insert a tab
  652. ・ tabsToSpaces - convert tabs in selection to spaces.
  653. ・ tclFileCompletion - completes the previous word as a
  654.   file is in a shell window
  655. ・ tclResult - displays a dialog showing the result of 
  656.   the last TCL evaluation.
  657. ・ thinkReference <-t|-l> <think reference page> - Interact with Think 
  658.   Reference 2.0. '-t' retrieves a template without leaving Alpha, '-l' 
  659.   switches to Think Reference and goes to the specified page.
  660. ・ ticks
  661.   Returns the current TickCount. Ticks are 60ths of a seconds. TickCount is the 
  662.   number of ticks since the Macintosh was started. The command:
  663.         puts stdout [expr "[ticks] / 60"]
  664.   will print the number of seconds since the Macintosh was booted.
  665. ・ toggleScrollbar - toggles horizontal scrollbar on frontmost window. 
  666.   Will not succeed if scrollbar scrolled.
  667. ・ traceFunc on <funcName> <winName> Trace 'funcName', send output to 
  668.                                     'winName'. 
  669.   traceFunc off                        Turn function tracing off.
  670.   traceFunc status                    Display current tracing status.
  671. ・ unascii  (see bindings)
  672. ・ unbind  (see bindings)
  673. ・ undo - undo the last action that has not been undone
  674. ・ unfloat <float num> - removes specified floating window. W/ no options 
  675.   lists all floating windows.
  676. ・ upcaseRegion - convert all lowercase letters to 
  677.   uppercase in the current region
  678. ・ upcaseWord - convert all lowercase letters to 
  679.   uppercase in the current word
  680. ・ version - Return string of the form "Alpha Version 5.31, Feb. 15, 1993".
  681. ・ watchCursor - turns the cursor into a a watch cursor.
  682. ・ wc <file>... - counts chars, words, lines of input files.
  683. ・ winNames [-f] - return a TCL list of all open windows. If '-f' option 
  684.   specified, complete pathnames are returned.
  685. ・ wrap - see the section on "Fill" routines.
  686. ・ wrapText
  687. ・ xtclcmd [-f filename] <cmdname> [argument_list]*
  688.   This command will load the external command cmdname and pass it the argument 
  689.   list [ cmdname argument_list... ]. External command are code resources of type 
  690.   XTCL. They may be located in the resource fork of the tickle application, or they 
  691.   may be located in a file named XTCL File in the same directory as the tickle 
  692.   application. If the optional -f filename is included, the external command will first 
  693.   be loaded from filename before the other two files.
  694.   See the appendix for a detailed description of the external tcl command interface. 
  695.   See the accompanying sources for an example of writing an XTCL.
  696. ・ yank - insert the last piece of deleted text of less
  697.   than 1k. Consecutive deletes are concatenated.
  698.   together.
  699. ・ zapInvisibles - removes chars < ascii 32, except for
  700.   LF's and CR's.
  701. ・ zoom - zooms the current window
  702.